<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArExitErrorSource Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArExitErrorSource.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classArExitErrorSource-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArExitErrorSource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Small interface for obtaining exit-on-error information.  
 <a href="classArExitErrorSource.html#details">More...</a></p>

<p><code>#include &lt;ArExitErrorSource.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6646a7166d60ddaefb26980570454fce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6646a7166d60ddaefb26980570454fce"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArExitErrorSource.html#a6646a7166d60ddaefb26980570454fce">ArExitErrorSource</a> ()</td></tr>
<tr class="memdesc:a6646a7166d60ddaefb26980570454fce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a6646a7166d60ddaefb26980570454fce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8377301b83b5582bb7fbc4e197656de8"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArExitErrorSource.html#a8377301b83b5582bb7fbc4e197656de8">getExitErrorCode</a> () const =0</td></tr>
<tr class="memdesc:a8377301b83b5582bb7fbc4e197656de8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error code used for the exit call.  <a href="#a8377301b83b5582bb7fbc4e197656de8">More...</a><br /></td></tr>
<tr class="separator:a8377301b83b5582bb7fbc4e197656de8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ae24ae4d82a2cc4328a03f58e4a93d0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArExitErrorSource.html#a4ae24ae4d82a2cc4328a03f58e4a93d0">getExitErrorDesc</a> (char *buf, int bufLen)=0</td></tr>
<tr class="memdesc:a4ae24ae4d82a2cc4328a03f58e4a93d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a textual description of the error source.  <a href="#a4ae24ae4d82a2cc4328a03f58e4a93d0">More...</a><br /></td></tr>
<tr class="separator:a4ae24ae4d82a2cc4328a03f58e4a93d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63e39f204ac2800709f65a3ff7bad274"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArExitErrorSource.html#a63e39f204ac2800709f65a3ff7bad274">getExitErrorUserDesc</a> (char *buf, int bufLen)=0</td></tr>
<tr class="memdesc:a63e39f204ac2800709f65a3ff7bad274"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a textual description of the error source intended for a user (it will be prefixed by something stating the action taking place)  <a href="#a63e39f204ac2800709f65a3ff7bad274">More...</a><br /></td></tr>
<tr class="separator:a63e39f204ac2800709f65a3ff7bad274"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f4f4bf8d3dbe6fe586d8152382e7970"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f4f4bf8d3dbe6fe586d8152382e7970"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArExitErrorSource.html#a1f4f4bf8d3dbe6fe586d8152382e7970">~ArExitErrorSource</a> ()</td></tr>
<tr class="memdesc:a1f4f4bf8d3dbe6fe586d8152382e7970"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a1f4f4bf8d3dbe6fe586d8152382e7970"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Small interface for obtaining exit-on-error information. </p>
<p><a class="el" href="classArExitErrorSource.html" title="Small interface for obtaining exit-on-error information. ">ArExitErrorSource</a> may be implemented by classes that wish to provide information if and when they cause an erroneous application exit. The use of this interface is entirely at the discretion of the application. <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> does not invoke its methods. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8377301b83b5582bb7fbc4e197656de8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int ArExitErrorSource::getExitErrorCode </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the error code used for the exit call. </p>
<p>Ideally, the returned error code should be unique across all error sources. (Past implementations have the method spec and body on a single line so that it's easily searchable... Current implementations have that OR this string on a line so that it'll show up searchable easily still). </p>

</div>
</div>
<a class="anchor" id="a4ae24ae4d82a2cc4328a03f58e4a93d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArExitErrorSource::getExitErrorDesc </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>bufLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a textual description of the error source. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>a char array in which the method puts the output error description </td></tr>
    <tr><td class="paramname">bufLen</td><td>the int number of char's in the array </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool true if the description was successfully written; false if an error occurred </dd></dl>

</div>
</div>
<a class="anchor" id="a63e39f204ac2800709f65a3ff7bad274"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArExitErrorSource::getExitErrorUserDesc </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>bufLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a textual description of the error source intended for a user (it will be prefixed by something stating the action taking place) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buf</td><td>a char array in which the method puts the output user error description </td></tr>
    <tr><td class="paramname">bufLen</td><td>the int number of char's in the array </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool true if the description was successfully written; false if an error occurred </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ArExitErrorSource.h</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArExitErrorSource.html">ArExitErrorSource</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
